Skip to content

Conversation

@petebacondarwin
Copy link
Contributor

@petebacondarwin petebacondarwin commented Nov 3, 2025

Summary

This PR documents the WRANGLER_OUTPUT_FILE_PATH and WRANGLER_OUTPUT_FILE_DIRECTORY environment variables that enable capturing Wrangler command output in structured ND-JSON format for CI/CD pipelines and automation tools.

Changes:

  • Added reference documentation for both environment variables in the system environment variables page
  • Added usage notes to wrangler deploy, wrangler versions upload/deploy, and wrangler pages deploy command sections

Key details:

  • WRANGLER_OUTPUT_FILE_PATH specifies an exact file path for output
  • WRANGLER_OUTPUT_FILE_DIRECTORY specifies a directory where a randomly-named file will be created
  • Output format is ND-JSON (newline-delimited JSON)
  • WRANGLER_OUTPUT_FILE_PATH takes precedence over WRANGLER_OUTPUT_FILE_DIRECTORY when both are set

Related resources:

Review checklist

Please verify:

  1. ✅ Anchor links to #supported-environment-variables resolve correctly
  2. ⚠️ Heading level consistency - I used ### for deploy/versions sections but #### for pages deploy section (may be intentional based on document structure)
  3. ✅ Command coverage is complete - included deploy, versions upload/deploy, and pages deploy based on code research
  4. ✅ Technical accuracy of ND-JSON format description and precedence rules

Documentation checklist

  • Is there a changelog entry (guidelines)?
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes. Not applicable - minor documentation additions
  • Files which have changed name or location have been allocated redirects. Not applicable - no files renamed or moved

…ECTORY environment variables

Add documentation for the WRANGLER_OUTPUT_FILE_PATH and WRANGLER_OUTPUT_FILE_DIRECTORY
environment variables that allow capturing Wrangler command output in ND-JSON format.

Documentation added to:
- System environment variables reference page
- wrangler deploy command
- wrangler versions upload and deploy commands
- wrangler pages deploy command

These environment variables are useful for CI/CD pipelines and automation tools
that need programmatic access to deployment information.

Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
Copy link

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/changelog/ @cloudflare/pm-changelogs, @cloudflare/pcx-technical-writing
/src/content/docs/workers/wrangler/ @cloudflare/wrangler, @irvinebroque, @kodster28, @cloudflare/pcx-technical-writing, @cloudflare/workers-runtime-1

devin-ai-integration bot and others added 2 commits November 3, 2025 21:00
…ment variables

Add a comprehensive example showing the ND-JSON format of the output file,
including sample entries for wrangler-session and deploy operations, along
with descriptions of other entry types (version-upload, version-deploy,
pages-deploy, command-failed).

Co-Authored-By: [email protected] <[email protected]>
Add changelog entry describing the new WRANGLER_OUTPUT_FILE_PATH and
WRANGLER_OUTPUT_FILE_DIRECTORY environment variables that allow capturing
Wrangler command output in structured ND-JSON format for CI/CD pipelines.

Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration devin-ai-integration bot requested a review from a team as a code owner November 3, 2025 21:09
@petebacondarwin petebacondarwin enabled auto-merge (squash) November 3, 2025 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants